/*
 *  Copyright 2009 Lucas Nazário dos Santos
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package net.sourceforge.retriever;

/**
 * Represents a crawler event.
 */
public class Event {


	/**
	 * This event is issued right after the crawler starts.
	 */
	public static final Event STARTED = new Event("Started");

	/**
	 * Event issued when someone attempts to stop the crawler.
	 */
	public static final Event STOPPING = new Event("Stopping");

	/**
	 * Event issued right after the crawling process ends.
	 */
	public static final Event FINISHED = new Event("Finished");

	private final String name;

	private Event(final String name) {
		this.name = name;
	}

	/**
	 * Returns the event name.
	 */
	public String getName() {
		return this.name;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((name == null) ? 0 : name.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		final Event other = (Event) obj;
		if (name == null) {
			if (other.name != null)
				return false;
		} else if (!name.equals(other.name))
			return false;
		return true;
	}
}